core

object core

Wrappers for @actions/core. Most are deprecated in favor of the specialized extensions.

Functions

addPath

fun addPath(inputPath: String)

debug

fun debug(message: String)

endGroup

fun endGroup()

error

fun error(message: String)

fun error(exception: Throwable)

fun error(message: String, annotationProperties: AnnotationProperties)

fun error(exception: Throwable, annotationProperties: AnnotationProperties)

exportVariable

fun exportVariable(name: String, value: String)

exportVariableStringify

fun exportVariableStringify(name: String, value: Any)

getOptionalInput

fun getOptionalInput(name: String, trimWhitespace: Boolean = true): String?

getRequiredInput

fun getRequiredInput(name: String, trimWhitespace: Boolean = true): String

Gets the input, or throws IllegalStateException.

getRequiredState

fun getRequiredState(name: String): String

getState

fun getState(name: String): String?

info

fun info(message: String)

issueCommand

fun issueCommand(command: String, value: String, vararg properties: Pair<String, String>)

Issue a GitHub Action command.

fun issueCommand(command: String, value: String, properties: Map<String, String> = emptyMap())

Issue a GitHub Action command.

issueFileCommand

fun issueFileCommand(command: String, message: String)

Issue a GitHub Action file command.

notice

fun notice(message: String)

fun notice(exception: Throwable)

fun notice(message: String, annotationProperties: AnnotationProperties)

fun notice(exception: Throwable, annotationProperties: AnnotationProperties)

saveState

fun saveState(name: String, value: String)

saveStateStringify

fun saveStateStringify(name: String, value: Any)

setCommandEcho

fun setCommandEcho(enabled: Boolean)

setFailed

fun setFailed(message: String)

fun setFailed(exception: Throwable)

setOutput

fun setOutput(name: String, value: String)

setOutputStringify

fun setOutputStringify(name: String, value: Any)

setSecret

fun setSecret(secret: String)

startGroup

fun startGroup(name: String)

warning

fun warning(message: String)

fun warning(exception: Throwable)

fun warning(message: String, annotationProperties: AnnotationProperties)

fun warning(exception: Throwable, annotationProperties: AnnotationProperties)

withGroup

inline fun <R> withGroup(name: String, block: () -> R): R

Properties

echoCommands

var echoCommands: Boolean?

isDebug

val isDebug: Boolean

Sources

js source